<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_sditxss: xv_sditxss_log.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_sditxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xv__sditxss__log_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xv_sditxss_log.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   jsr  07/17/17 Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6018ef35dec27977430d676e948371df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__sditxss__log_8c.html#a6018ef35dec27977430d676e948371df">XV_SdiTxSs_LogReset</a> (<a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a6018ef35dec27977430d676e948371df"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will reset the driver's logging mechanism.  <a href="#a6018ef35dec27977430d676e948371df">More...</a><br/></td></tr>
<tr class="separator:a6018ef35dec27977430d676e948371df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a986a5881e775194f864ebaa1f055afa6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__sditxss__log_8c.html#a986a5881e775194f864ebaa1f055afa6">XV_SdiTxSs_LogWrite</a> (<a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *InstancePtr, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553">XV_SdiTxSs_LogEvent</a> Evt, u8 Data)</td></tr>
<tr class="memdesc:a986a5881e775194f864ebaa1f055afa6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will insert an event in the driver's logginc mechanism.  <a href="#a986a5881e775194f864ebaa1f055afa6">More...</a><br/></td></tr>
<tr class="separator:a986a5881e775194f864ebaa1f055afa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e203857196f292dfad66248d204e2f8"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__sditxss__log_8c.html#a2e203857196f292dfad66248d204e2f8">XV_SdiTxSs_LogRead</a> (<a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a2e203857196f292dfad66248d204e2f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will read the last event from the log.  <a href="#a2e203857196f292dfad66248d204e2f8">More...</a><br/></td></tr>
<tr class="separator:a2e203857196f292dfad66248d204e2f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7c1a04ba9452c9ce929d7d4a54a34ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__sditxss__log_8c.html#ad7c1a04ba9452c9ce929d7d4a54a34ed">XV_SdiTxSs_LogDisplay</a> (<a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ad7c1a04ba9452c9ce929d7d4a54a34ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will print the entire log.  <a href="#ad7c1a04ba9452c9ce929d7d4a54a34ed">More...</a><br/></td></tr>
<tr class="separator:ad7c1a04ba9452c9ce929d7d4a54a34ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ad7c1a04ba9452c9ce929d7d4a54a34ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_SdiTxSs_LogDisplay </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will print the entire log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___sdi_tx_ss.html" title="The XV_SdiTxSs driver instance data. ">XV_SdiTxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553a63589926dcc66160bc9d119c338ebc46">XV_SDITXSS_LOG_EVT_AXI4SVIDLOCK</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553a1bbcbe23ea627a2ab2a96ed9f403666c">XV_SDITXSS_LOG_EVT_CEALIGN</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553a70c37767e46297173c60928158b84041">XV_SDITXSS_LOG_EVT_NONE</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553a9bca7aaeaaba359457841df66108f549">XV_SDITXSS_LOG_EVT_OVERFLOW</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553a4f123e9b8fe60da8e0840471c809e4d9">XV_SDITXSS_LOG_EVT_RESET</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553ae22f2169dcf22ddb067ac470c4c3ea28">XV_SDITXSS_LOG_EVT_SDITX_INIT</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553ab889ddf1b34b030579592b25437c2441">XV_SDITXSS_LOG_EVT_START</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553aeac1a799ac1fe555cd20ff918aa62881">XV_SDITXSS_LOG_EVT_STOP</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553a33768bda2ad7a120398f40e165d1d61d">XV_SDITXSS_LOG_EVT_STREAMDOWN</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553a9e58b21831ecfa79fd021ddb6eb92e94">XV_SDITXSS_LOG_EVT_STREAMSTART</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553a8d9f788e38c6a09a001b0334ac33aa5c">XV_SDITXSS_LOG_EVT_STREAMUP</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553aaefd873e00cbcf42d8df28b0ca3def64">XV_SDITXSS_LOG_EVT_UNDERFLOW</a>, <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553afc8392e1e0ed781f3a833f6a2b292c3c">XV_SDITXSS_LOG_EVT_VTC_INIT</a>, and <a class="el" href="xv__sditxss_8h.html#a2e203857196f292dfad66248d204e2f8">XV_SdiTxSs_LogRead()</a>.</p>

</div>
</div>
<a class="anchor" id="a2e203857196f292dfad66248d204e2f8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XV_SdiTxSs_LogRead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will read the last event from the log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___sdi_tx_ss.html" title="The XV_SdiTxSs driver instance data. ">XV_SdiTxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The log data.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_tx_ss___log.html#a9837f18c49e51f4217f2a3f0fa140ed6">XV_SdiTxSs_Log::DataBuffer</a>, <a class="el" href="struct_x_v___sdi_tx_ss___log.html#a9195a8738123026919280b2386633ddb">XV_SdiTxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___sdi_tx_ss.html#a310541f8343d83af656a6b8a313a3d4c">XV_SdiTxSs::Log</a>, and <a class="el" href="struct_x_v___sdi_tx_ss___log.html#a862a821dfbcb36684f083fa35415d657">XV_SdiTxSs_Log::TailIndex</a>.</p>

<p>Referenced by <a class="el" href="xv__sditxss__log_8c.html#ad7c1a04ba9452c9ce929d7d4a54a34ed">XV_SdiTxSs_LogDisplay()</a>.</p>

</div>
</div>
<a class="anchor" id="a6018ef35dec27977430d676e948371df"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_SdiTxSs_LogReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will reset the driver's logging mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the xv_sditxss core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_tx_ss___log.html#a9195a8738123026919280b2386633ddb">XV_SdiTxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___sdi_tx_ss.html#a310541f8343d83af656a6b8a313a3d4c">XV_SdiTxSs::Log</a>, and <a class="el" href="struct_x_v___sdi_tx_ss___log.html#a862a821dfbcb36684f083fa35415d657">XV_SdiTxSs_Log::TailIndex</a>.</p>

</div>
</div>
<a class="anchor" id="a986a5881e775194f864ebaa1f055afa6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_SdiTxSs_LogWrite </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_tx_ss.html">XV_SdiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553">XV_SdiTxSs_LogEvent</a>&#160;</td>
          <td class="paramname"><em>Evt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will insert an event in the driver's logginc mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___sdi_tx_ss.html" title="The XV_SdiTxSs driver instance data. ">XV_SdiTxSs</a> core instance. </td></tr>
    <tr><td class="paramname">Evt</td><td>is the event type to log. </td></tr>
    <tr><td class="paramname">Data</td><td>is the associated data for the event.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_tx_ss___log.html#a9837f18c49e51f4217f2a3f0fa140ed6">XV_SdiTxSs_Log::DataBuffer</a>, <a class="el" href="struct_x_v___sdi_tx_ss___log.html#a9195a8738123026919280b2386633ddb">XV_SdiTxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___sdi_tx_ss.html#a310541f8343d83af656a6b8a313a3d4c">XV_SdiTxSs::Log</a>, <a class="el" href="struct_x_v___sdi_tx_ss___log.html#a862a821dfbcb36684f083fa35415d657">XV_SdiTxSs_Log::TailIndex</a>, and <a class="el" href="xv__sditxss_8h.html#afe1f5ed1c9022fbb0da8ddfbdf2d7553abde742780ffd0391fac7379cc7052224">XV_SDITXSS_LOG_EVT_DUMMY</a>.</p>

<p>Referenced by <a class="el" href="xv__sditxss_8h.html#aa665c8a153ad4e024a9b02d5fc4fb691">XV_SdiTxSs_Stop()</a>, <a class="el" href="xv__sditxss_8h.html#ac527da1833b83b72a0bf989e4230c8ae">XV_SdiTxSs_StreamConfig()</a>, <a class="el" href="xv__sditxss_8h.html#aaedc93d7d8d155ea9407b0627508e6b6">XV_SdiTxSs_StreamStart()</a>, <a class="el" href="group__v__sditxss.html#ga947c864c39e22328573d30b2cd0f4ca3">XV_SdiTxSs_SubcoreInitSdiTx()</a>, and <a class="el" href="group__v__sditxss.html#ga014e94de29a924cc95a2282fe8abf748">XV_SdiTxSs_SubcoreInitVtc()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
